<html>
<body>
<h1>Help Plugin</h1>
<p>The help plugin generates and displays help for projects, plugins, dependency sets and XML catalogs.</p>

<div id="after-summary">
    <p>Users of quokka will only be concerned with <tt>help</tt> and <tt>report</tt> related targets. Developers
    can use the <tt>generate-help</tt> and <tt>generate-summary</tt> targets to automatically generate the bulk
    of plugin documentation.</p>
</div>
<div id="help">
    <p><b>Properties:</b></p>
    <ul>
        <li><b>launch</b> <i>Optional.</i> If <tt>true</tt>, automatically launches the browser with the generated help.
        </li>
        <li><b>id</b> <i>Optional.</i> If an <tt>id</tt> is specified (usually via <tt>-Did=&lt;id&gt;</tt>) then help
            for given id will be
            extracted and displayed
        </li>
        <li><b>target</b> <i>Optional.</i> If a <tt>target</tt> is (usually via <tt>-Dtarget=&lt;target&gt;</tt>) then
            help for the plugin
            that introduced the given target will be extracted and displayed.
        </li>
    </ul>
</div>
<div id="aggregate-report">
    <p>If you are doing a multi-project build, you can produce aggregate project reports. For this to
    work, make sure all of the sub projects enable the <tt>collect</tt> target.</p>
</div>
<div id="generate-help">
    <p>If you are developing a plugin, dependency set or XML catalog, this target will merge together
    help you write with metadata about the artifact you are developing. To generate help, you need
    to supply and XHTML help file and use specific tags and ids. The following describes how the help
        is generated:</p>
    <ul>
        <li>The title of the help is taken from the first <tt>h1</tt> tag in the help file</li>
        <li>The <tt>id</tt> of the artifact is then added automatically</li>
        <li>The short description is taken from the first paragraph (<tt>p</tt>) element in the
        help file</li>
        <li>Any help file content with a <tt>div</tt> with an <tt>id</tt> of <tt>content-before</tt> is then added.</li>
        <li>Help for the artifact is automatically generated - the content varies depending
            on the kind of artifact. If the artifact is a plugin, then the following additional
            steps are performed.
            <ul>
                <li>Any help file content with a <tt>div</tt> with an <tt>id</tt> of <tt>after-summary</tt> is then added.</li>
                <li>For each target, summary content is generated and then any help content with a <tt>div</tt> with an <tt>id</tt>
                    that matches the target name is added.</li>
                <li>After all targets, plugin paths information is added.</li>
            </ul>
        </li>
        <li>Finally, any help file content with a <tt>div</tt> with an <tt>id</tt> of <tt>content-after</tt> is then added.</li>
    </ul>
</div>
</body>
</html>